

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Using the API &mdash; Apache Usergrid 1.0 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/>
        <link rel="next" title="The Usergrid Data Store" href="../data-storage/data-store-dbms.html"/>
        <link rel="prev" title="Using a Sandbox Application" href="using-a-sandbox-app.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        

        
          <a href="../index.html" class="icon icon-home"> Apache Usergrid
        

        
        </a>

        
          
          
            <div class="version">
              1.0
            </div>
          
        

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
          
          
              <p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Documentation Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="creating-account.html">Creating an Usergrid Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Using the API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#supported-http-methods">Supported HTTP methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="#base-url">Base URL</a></li>
<li class="toctree-l2"><a class="reference internal" href="#request-construction">Request construction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#accessing-collections">Accessing collections</a></li>
<li class="toctree-l2"><a class="reference internal" href="#accessing-entities">Accessing entities</a></li>
<li class="toctree-l2"><a class="reference internal" href="#issuing-queries">Issuing queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="#authentication-oauth">Authentication (OAuth)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#response-format">Response format</a></li>
<li class="toctree-l2"><a class="reference internal" href="#sdks">SDKs</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Data Storage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Queries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters &amp; clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; data types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Entity Connections</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Push Notifications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/overview.html">Push notifications overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/adding-push-support.html">Adding push notifications support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/getting-started.html">Getting started with push notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/tutorial.html">Tutorial: Push notifications sample app</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/registering.html">Registering with a notification service</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-notifiers.html">Creating notifiers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/managing-users-and-devices.html">Managing users and devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-and-managing-notifications.html">Creating and managing notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption"><span class="caption-text">Security &amp; Authentication</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users &amp; app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
</ul>
<p class="caption"><span class="caption-text">User Management &amp; Social Graph</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management &amp; social graph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li>
</ul>
<p class="caption"><span class="caption-text">Geo-location</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Assets &amp; Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters &amp; Events</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; incrementing counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
</ul>
<p class="caption"><span class="caption-text">Organizations &amp; Applications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#sub-types">Sub-Types</a></li>
</ul>
<p class="caption"><span class="caption-text">Client SDKs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
</ul>
<p class="caption"><span class="caption-text">Installing the Stack</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/deployment-guide.html">Usergrid 2.1.0 (unreleased) Deployment Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">More about Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations &amp; Videos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
</ul>

          
        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index.html">Apache Usergrid</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index.html">Docs</a> &raquo;</li>
      
    <li>Using the API</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/getting-started/using-the-api.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="using-the-api">
<h1>Using the API<a class="headerlink" href="#using-the-api" title="Permalink to this headline">¶</a></h1>
<p>Usergrid uses a pure REST (Representational State Transfer) API built as
a collection of resources. Resource locations are described by paths
that are related intrinsically to collections and entities in
collections.</p>
<p>This section gives several examples of how to construct API requests. To
focus on what&#8217;s important, the examples use an abbreviated path that
starts after the application UUID, or application name. For example,
instead of giving a fully qualified path name as in:</p>
<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/your-org/your-app/users
</pre></div>
</div>
<p>the example simply lists this:</p>
<div class="highlight-python"><div class="highlight"><pre>/users
</pre></div>
</div>
<div class="section" id="supported-http-methods">
<h2>Supported HTTP methods<a class="headerlink" href="#supported-http-methods" title="Permalink to this headline">¶</a></h2>
<p>When building a REST API, the challenge is to represent the data and the
action upon the data as a path to a resource that can be created,
retrieved, updated, or deleted. The HTTP methods POST, GET, PUT, and
DELETE correspond to the actions that are applied to resources.</p>
</div>
<div class="section" id="base-url">
<h2>Base URL<a class="headerlink" href="#base-url" title="Permalink to this headline">¶</a></h2>
<p>The base url for all requests made to Usergrid depends on where you have
Usergrid installed. If you are using Apigee&#8217;s trial Usergrid service,
the base URL is <code class="docutils literal"><span class="pre">https://api.usergrid.com.</span></code></p>
</div>
<div class="section" id="request-construction">
<h2>Request construction<a class="headerlink" href="#request-construction" title="Permalink to this headline">¶</a></h2>
<p>Usergrid interprets the URL resource path as a list of names, UUIDs, or
queries. The basic path format is:</p>
<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/&lt;org-uuid|org-name&gt;/&lt;app-uuid|app-name&gt;/&lt;collection-name&gt;/&lt;entity-uuid|entity-name&gt;
</pre></div>
</div>
<p>Note: You cannot mix UUIDs and names in the URL resource path. For
example, the following is incorrect:</p>
<div class="highlight-python"><div class="highlight"><pre>https://api.usergrid.com/your-org/62de5d97-d28c-11e1-8d5c-12313b01d5c1/users/john.doe
</pre></div>
</div>
</div>
<div class="section" id="accessing-collections">
<h2>Accessing collections<a class="headerlink" href="#accessing-collections" title="Permalink to this headline">¶</a></h2>
<p>To access all entities in a collection, specify the path as follows:</p>
<div class="highlight-python"><div class="highlight"><pre>/users
</pre></div>
</div>
<p>Such a request retrieves the first 10 entities in the collection /users
sorted by their entity UUID.</p>
</div>
<div class="section" id="accessing-entities">
<h2>Accessing entities<a class="headerlink" href="#accessing-entities" title="Permalink to this headline">¶</a></h2>
<p>To access an entity in a collection, specify the path as follows:</p>
<div class="highlight-python"><div class="highlight"><pre>/&lt;collection&gt;/&lt;uuid|name&gt;
</pre></div>
</div>
<p>where <code class="docutils literal"><span class="pre">&lt;collection&gt;</span></code> is the collection name, and is the entity’s uuid
or name.</p>
<p>To access a user in the users collection, specify the path as follows:</p>
<div class="highlight-python"><div class="highlight"><pre>/users/&lt;uuid|username|email_address&gt;
</pre></div>
</div>
<p>where <code class="docutils literal"><span class="pre">&lt;uuid|username|email_address&gt;</span></code> is the user’s uuid, username, or
email address.</p>
<p>For example, the following request retrieves the entity named dino from
the dogs collection:</p>
<div class="highlight-python"><div class="highlight"><pre>/dogs/dino
</pre></div>
</div>
</div>
<div class="section" id="issuing-queries">
<h2>Issuing queries<a class="headerlink" href="#issuing-queries" title="Permalink to this headline">¶</a></h2>
<p>You can issue a query in an API request that retrieves items from a
collection. Here is the typical format for queries:</p>
<div class="highlight-python"><div class="highlight"><pre>/&lt;collection&gt;?ql=&lt;query&gt;
</pre></div>
</div>
<p>where is a query in the query language.</p>
<p>For example, this request retrieves users whose Facebook first name is
john:</p>
<div class="highlight-python"><div class="highlight"><pre>/users?ql=select * where facebook.first_name =&#39;john&#39;
</pre></div>
</div>
<p>For further information about queries, see <a class="reference external" href="../data-queries/querying-your-data.html">Querying your
Data</a></p>
</div>
<div class="section" id="authentication-oauth">
<h2>Authentication (OAuth)<a class="headerlink" href="#authentication-oauth" title="Permalink to this headline">¶</a></h2>
<p>Usergrid implements the OAuth 2.0 standard for authenticating users,
clients and API requests.</p>
<p>Generally, you will generate a token for every user of your app by
providing the user&#8217;s username and password. The token can then be sent
with all API requests to ensure each user is only able to access and
modify the resources you have granted them rights to.</p>
<p>Note that by default access tokens are not needed to make requests to
the default sandbox application in an organization.</p>
<p>For more information on generating and using access tokens, see
Authenticating users and application clients and Authenticating API
requests.</p>
</div>
<div class="section" id="response-format">
<h2>Response format<a class="headerlink" href="#response-format" title="Permalink to this headline">¶</a></h2>
<p>All API methods return a response object that typically contains an
array of entities:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span>
    <span class="o">...</span>
  <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Not everything can be included inside the entity, and some of the data
that gets associated with specific entities isn&#8217;t part of their
persistent representation. This is metadata, and it can be part of the
response as well as associated with a specific entity. Metadata is just
an arbitrary key/value JSON structure.</p>
<p>For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">{</span>
    <span class="p">{</span>
      <span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;ed&quot;</span><span class="p">,</span>
      <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s">&quot;activities&quot;</span><span class="p">,</span> <span class="s">&quot;groups&quot;</span><span class="p">,</span> <span class="s">&quot;followers&quot;</span><span class="p">]</span>
      <span class="p">}</span>
    <span class="p">}</span>
  <span class="p">},</span>
  <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
    <span class="s">&quot;foo&quot;</span> <span class="p">:</span> <span class="p">[</span><span class="s">&quot;bar&quot;</span><span class="p">,</span> <span class="s">&quot;baz&quot;</span><span class="p">]</span>
  <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>For example, here is the response to a basic GET for a user entity:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
  <span class="s">&quot;action&quot;</span> <span class="p">:</span> <span class="s">&quot;get&quot;</span><span class="p">,</span>
  <span class="s">&quot;application&quot;</span> <span class="p">:</span> <span class="s">&quot;f34f4222-a166-11e2-a7f7-02e81adcf3d0&quot;</span><span class="p">,</span>
  <span class="s">&quot;params&quot;</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
  <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/users&quot;</span><span class="p">,</span>
  <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/your-org/your-app/users&quot;</span><span class="p">,</span>
  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
    <span class="s">&quot;uuid&quot;</span> <span class="p">:</span> <span class="s">&quot;503f17da-ec39-11e3-a0dd-a554b7fbd57a&quot;</span><span class="p">,</span>
    <span class="s">&quot;type&quot;</span> <span class="p">:</span> <span class="s">&quot;user&quot;</span><span class="p">,</span>
    <span class="s">&quot;created&quot;</span> <span class="p">:</span> <span class="mi">1401921665485</span><span class="p">,</span>
    <span class="s">&quot;modified&quot;</span> <span class="p">:</span> <span class="mi">1401921665485</span><span class="p">,</span>
    <span class="s">&quot;username&quot;</span> <span class="p">:</span> <span class="s">&quot;someUser&quot;</span><span class="p">,</span>
    <span class="s">&quot;email&quot;</span> <span class="p">:</span> <span class="s">&quot;someUser@yourdomain.com&quot;</span><span class="p">,</span>
    <span class="s">&quot;activated&quot;</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
    <span class="s">&quot;picture&quot;</span> <span class="p">:</span> <span class="s">&quot;http://www.gravatar.com/avatar/dc5d478e9c029853fbd025bed0dc51f8&quot;</span><span class="p">,</span>
    <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
      <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a&quot;</span><span class="p">,</span>
      <span class="s">&quot;sets&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;rolenames&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/roles&quot;</span><span class="p">,</span>
        <span class="s">&quot;permissions&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/permissions&quot;</span>
      <span class="p">},</span>
      <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;activities&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/activities&quot;</span><span class="p">,</span>
        <span class="s">&quot;devices&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/devices&quot;</span><span class="p">,</span>
        <span class="s">&quot;feed&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/feed&quot;</span><span class="p">,</span>
        <span class="s">&quot;groups&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/groups&quot;</span><span class="p">,</span>
        <span class="s">&quot;roles&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/roles&quot;</span><span class="p">,</span>
        <span class="s">&quot;following&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/following&quot;</span><span class="p">,</span>
        <span class="s">&quot;followers&quot;</span> <span class="p">:</span> <span class="s">&quot;/users/503f17da-ec39-11e3-a0dd-a554b7fbd57a/followers&quot;</span>
      <span class="p">}</span>
    <span class="p">}</span>
  <span class="p">}</span> <span class="p">],</span>
  <span class="s">&quot;timestamp&quot;</span> <span class="p">:</span> <span class="mi">1401921673597</span><span class="p">,</span>
  <span class="s">&quot;duration&quot;</span> <span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
  <span class="s">&quot;organization&quot;</span> <span class="p">:</span> <span class="s">&quot;your-org&quot;</span><span class="p">,</span>
  <span class="s">&quot;applicationName&quot;</span> <span class="p">:</span> <span class="s">&quot;your-app&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="sdks">
<h2>SDKs<a class="headerlink" href="#sdks" title="Permalink to this headline">¶</a></h2>
<p>To make the integration of Usergrid features into your application code
quicker and easier, Usegrid offers SDKs in a variety of languages. The
SDKs contain language-specific methods that allow you to issue API
requests from your application code in your preferred language. SDKs are
available for the following languages:</p>
<ul class="simple">
<li>iOS</li>
<li>Android</li>
<li>JavaScript/HTML5</li>
<li>Node.js</li>
<li>Ruby</li>
<li>.NET</li>
</ul>
<p>For more information, see SDKs.</p>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../data-storage/data-store-dbms.html" class="btn btn-neutral float-right" title="The Usergrid Data Store" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="using-a-sandbox-app.html" class="btn btn-neutral" title="Using a Sandbox Application" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2013-2015, Apache Usergrid.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'1.0',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>